sisHYD User Guide

sisHYD import of HR data

The following section describes the structure of text files for an import using the sisHYD text interface. The GIS sisNET exports network data in the text format described.

Specification of the import text interface

  • The file consists of a series of data blocks, where each data block describes exactly one object
  • A data block is introduced with a keyword. On the following lines pairs of field keyword and value are listed, which are separated from each other by exactly one TAB. Keyword and value must be present.
  • Keywords are written exclusively in CAPITAL LETTERS.
  • A block is completed by a blank line (this also applies for the last block of the text file).
  • All unit-bound dimensions are entered in the unit which is described in the sisHYD database sketch. In general, these are the SI units (length, diameter in [m], performance in [W], flow rates in [Nm3/s], mass flows in [kg/s], temperature in [°C]).
  • Numeric values are displayed as cultural neutral formatting, i.e. a point is used as a separator, there is no thousand separator.
    • Valid decimal numbers
      • 123
      • 123.456
      • 12.3456e-6
    • Invalid decimal numbers
      • 1.000.000
      • 5,678
      • 1.234,678
  • All compulsory fields must be listed for a block. Compulsory field which run a default value are excepted. If the compulsory field is missing it is taken up with the default value.
  • Date and numerical data take place in the UTC format
  • (YYYY-MM-DD HH:MM:SSZ), e.g.: 2008-11-21 14:28:13Z.

sisHYD imports the following data blocks (grey) from the import file

  • All keywords of the import interface are strictly identical to the corresponding column names of the database draft.
  • Keywords in curly brackets are alternative names (old) which are still understood by the import format. They deviate from the convention and are replaced with by names that conform to convention for import files with format information.
  • The order of the data blocks is arbitrary in the old format. In the new format the first block is the VERSION. For all further blocks, data which are referenced are to be written before blocks which depend on these data. (e.g. Write pipe classes before pipe data which reference the pipe class).
    Note: For compatibility reasons the order is not yet checked. The integrity examination therefore only takes place when the project is opened by sisHYD. Incorrect data are announced and eliminated from the database.
    Note: From sisHYD version 08.05.01.13, default data are generated for the following tables if no row is present after the import.
    • Fields, which are marked "yes" in the compulsory column and have no default value must be filled!

Table 1

Block/field link Keyword Database Compulsory Default
File format (not in database) VERSION
Identification VERSION_ID Yes 080904
"Network" NETZ
Name NETZ_ID Yes
Number NETZ_NR Yes 1
Type of network (displays the number of leaders; for gas/water always 1) NETZTYP Yes 2
Medium MEDIUM Yes 0
Connection load ANSCHLUSS_LAST 0
Max. Pressure P_NENN 1600000
Max. Flow temperature TMAX_VORLAUF 130
Max. Return temperature TMAX_RUECKLAUF 90
Height of the air pressure measurement NULLPUNKT 0
Absolute pressure ABSOLUTDRUCK J
Atmospheric pressure LUFTDICHTE 1.293
Air pressure LUFTDRUCK 101325

Table 2

Block/field Database link Keyword Compulsory Default
Zone H_NETZTEIL
Name NETZTEIL_ID Yes
Number NETZTEIL_NR Yes 1
Barrier SPERRE
Correction wall roughness WANDRAUH_KORR 0
Correction factor for the wall roughness WANDRAUH_FAKTOR 1
Coefficient for correction of the heat transition coefficient WAERME_KOEFF_KORR 0
Factor for correction of the heat transition coefficient WAERME_KOEFF_FAKTOR 1
Const. Length addition LAENGEN_ZUSCHLAG 0
Factor for the length addition LAENGENZUSCHLAG_FAKTOR 1
Alternative H_VARIANTE
Name VARIANTE_ID Yes
Number VARIANTE_NR Yes 1
Description BESCHREIBUNG
Alternative zone allocation H_VARIANTE_NETZTEIL
Number of the variable VARIANTE_NR Yes
Number of the contained power supply unit NETZTEIL_NR Yes
Node KNOTEN
Name KNOTEN_ID Yes
Number KNOTEN_NR Yes
Assigned network NETZ_NR Yes 1
Network position NETZ_POSITION Yes 0
x-coordinate X_KOORD Yes
y-coordinate Y_KOORD Yes
z-coordinate Z_KOORD Yes
Generated GENERIERT 1
Amendment date GEAENDERT
Creation date ERSTELLT
Object identification from GIS GISID (MS_LINK)

Table 3

Block/field Database link Keyword Compulsory Default
(common element data) (ELEMENT) - !no valid data block!
Name ELEM_ID Yes
Number ELEM_NR Yes
Initial node ANFANGS_NR Yes 1
End node END_NR Yes 1
Assigned network NETZ_NR Yes 1
Assigned zone HIERARCHIE Yes 1
Network position NETZ_POSITION Yes 0
Generated GENERIERT 1
Amendment date GEAENDERT
Creation date ERSTELLT
Object identification from GIS GISID - (MS_LINK)
Steam trap H_STEAMTRAP - < ELEMENT
Efficiency EFFICIENCY Yes
Pipe ROHR {STRANG} - < ELEMENT
Pipe class ROHRKLASSEN_NR Yes 1
Length LAENGE Yes 1.0
Additional resistance ZUSATZWIDER 0
Default of an individual exterior temperature [°C], the value -1000 stands for no default T_AUSSEN Yes -1000
Price category PREISKATEGORIE 1
Can be isolated IST_ABSPERRBAR Yes N
Pump PUMPE - < ELEMENT
Assigned pump type, - 0 for default pump type PUMPENTYP_NR - {PUMPENTYP} 0
Cost factor KOSTENFAKTOR
Price category PREISKATEGORIE 1

Table 4

Block/Field Database link Keyword Compulsory Default
Valve VENTIL {ARMATUR} - < ELEMENT
Assigned valve type, 0 for type of default valve VENTILTYP_NR - {VENTILTYP} 0
Price category PREISKATEGORIE
Supplier VERSORGER {EINSPEISER} - < ELEMENT
Max. Feeding temperature MAX_TEMP 0
Const. pressure loss portion DRUCKVERLUST 0
Resistance WIDERSTAND 0
Resistance2 WIDERSTAND2 0
Max. Feed performance MAX_LEISTUNG 0
Max. mass flow. MAX_MSTROM 0
Max. Flow rate MAX_VSTROM 0
Heat production costs WAERME_KOSTEN 0
Consumer VERBRAUCHER - < ELEMENT
Name ELEM_ID Yes
Number ELEM_NR Yes
Nominal mass flow NENNMASSENSTROM
Connection load ANSCHLUSSLAST
Flow rate VOLUMENSTROM
Assigned consumer group GRUPPEN_NR Yes 1
Min. pressure loss V_MIN_DRUCKVERLUST 0
Max. pressure loss V_MAX_DRUCKVERLUST 0
Max. mass flow. V_MAX_MSTROM 0
Min. Flow temperature V_MIN_VORLAUFTEMP 0
Min. pressure height MIN_DRUCKHOEHE 0
Max. pressure height MAX_DRUCKHOEHE 0
Bypass diameter BYPASS 0

Table 5

Block/field - Database link Keyword Compulsory Default
Pipe inflexion points KNICKPUNKTE
Number ELEM_NR Yes
Serial inflexion point number (start each ELEM_NR with 1) KNICK_NR Yes
x-coordinate X_KOORD
y-coordinate Y_KOORD
z-coordinate Z_KOORD
Customer VERBR_DATEN {KUNDE}
Creation date ERSTELLT
Amendment date GEAENDERT
Generated GENERIERT 1
Name VERBRAUCHER_ID Yes
Number VERBRAUCHER_NR Yes
Connection node ANFANGS_KNR1 Yes
Mass flow heating MASSENSTROM 0
Connection value heating NENNLEISTUNG 0
Volume flow heating VOLUMENTSTROM 0
Consumer group heating GRUPPEN_NR Yes 1
Volume flow consumer group MASSENSTROM2 0
Connection value water production NENNLEISTUNG2 0
Volume flow water production VOLUMENTSTROM2 0
Consumer group water production GRUPPEN_NR2 Yes 1
Mass flow ventilation MASSENSTROM3 0
Connected load ventilation NENNLEISTUNG3 0
Volume flow ventilation VOLUMENTSTROM3 0
Consumer group ventilation GRUPPEN_NR3 Yes 1
Current amount of heat WAERMEMENGE1 - (WAERMEMENGE_1)
Current quantity of water WASSERMENGE1 - (WASSERMENGE_1)
Current volume VOLUMEN1 - (VOLUMEN_1)
Amount of heat previous year WAERMEMENGE2 - (WAERMEMENGE_2)
Quantity of water previous year WASSERMENGE2 - (WASSERMENGE_2)

Table 6

Block/field Database link Keyword Compulsory Default
Volume previous year VOLUMEN2 - (VOLUMEN_2)
Floor space WOHNFLAECHE
Bypass diameter BYPASS
First name VORNAME
Surname HAUSNAME
Street name STRASSE
Street number HAUSNUMMER
Postal/zip code PLZ
City ORT
First telephone number TEL_PRIVAT
Second telephone number TEL_ARBEIT
MESS_TYP
MESS_INSTALLATION
INSPEKTION
Code for the consumption accounting ABRECHNUNG
Minimum building height MIN_HOEHE
Maximum building height MAX_HOEHE
SPEICHER
TAUSCHER
DURCHLAUF
ALTERNATIV
Consumer group VERBR_GRUPPE
Creation date ERSTELLT
Amendment date GEAENDERT
Generated GENERIERT 1
Name GRUPPEN_ID Yes
Number GRUPPEN_NR Yes
Factor heating portion FAKTOR 1
Target temperature flow VORLAUF_SOLL 100
Target temperature return RUECKLAUF_SOLL 50
Sigma flow SIGMA_VORLAUF 0
Sigma load SIGMA_LAST 0
Retention time correction VERWEILZEIT 0
Min. Difference of pressure DIFFDRUCK_MIN 0
Min. Flow temperature TMIN_VORLAUF 0

Table 7

Block/field Database link Keyword Compulsory Default
Max. pressure at the customer P_MAX_ABNEHM 0
Min. pressure height at the customer MIN_DRUCKHOEHE 0
Max. pressure height at the customer MAX_DRUCKHOEHE 0
Consumption field with customer data VERBRAUCHSART 0
Yearly hours JAHRESSTUNDEN 0
Identifies the target consumption field at the consumer MEMO_NR 0
MITMENGENBEGRENZUNG 0
MENGENFAKTOR 1
Pipe class ROHRKLASSEN
Creation date ERSTELLT
Amendment date GEAENDERT
Generated GENERIERT 1
Name ROHRKLASSEN_ID Yes
Number ROHRKLASSEN_NR Yes 1
Inside diameter INN_DMESS Yes
Outside diameter AUSSENDURCHMESSER {AUSS_DMESS}
Retention coefficient VERWEIL_KOEFF Yes 1
Consider in design calculations DIMENSIONIERBAR Yes J
Wall roughness WANDRAU 1.0001
Heat coefficient WAERME_KOEFF
Heat transition coefficient KWERT
DRUCKSTUFE
LIEFERANT
BESTELL_NR
LECKDETEKT
NENNDURCHMESSER
AUSSENDURCHMESSER
MANTELDURCHMESSER
WANDSTAERKE - {WANDDICKE}
MATERIAL
ISOLIERUNG
GEWICHT

Table 8

Block/field Database link Keyword Compulsory Default
Prices for category 1 PREIS1
Prices for category 2 PREIS2
Prices for category 3 PREIS3
Prices for category 4 PREIS4
Prices for category 5 PREIS5
Prices for category 6 PREIS6
GESCHW_MAX
DELTAP_MAX
VERLEGEART
AUSSENTEMPERATUR
Flex pipe, J/N FLEXROHR
RILLENTIEFE
RILLENABSTAND
Type of pump PUMPENTYP
Creation date ERSTELLT
Amendment date GEAENDERT
Generated GENERIERT 1
Name PUMPENTYP Yes
Number PUMPENTYP_NR Yes
NENNDREHZAHL Yes
MAX_FOERDERSTROM
MIN_FOERDERSTROM
MAX_DREHZAHL 2000
MIN_DREHZAHL 1
G_WIRK_MIN
G_WIRK_MAX
HOEHE0 0
HOEHE1 0
HOHE2 0
LEISTUNG0 0
LEISTUNG1 0
LEISTUNG2 0
LEISTUNG3 0
NPSH0 0
NPSH1 0
NPSH2 0

Table 9

Block/field Database link Keyword Compulsory Default
NPSH3 0
MOTORLEISTUNG
PUMPENMODELL
LIEFERANT
BESTELL_NR
Prices for category 1 PREIS1
Prices for category 2 PREIS2
Prices for category 3 PREIS3
Prices for category 4 PREIS4
Prices for category 5 PREIS5
Prices for category 6 PREIS6
Creation date ERSTELLT
Amendment date GEAENDERT
Generated GENERIERT 1
Pump characteristic entry PUMPENKENNLINIEN
Number PUMPENTYP_NR Yes
Mass flow MASSENSTROM Yes
Delivery height FOERDERHOEHE Yes
Performance LEISTUNG 0
NPSH NPSH 0
Valve type VENTILTYP
Creation date ERSTELLT
Amendment date GEAENDERT
Generated GENERIERT 1
Name VENTILTYP Yes
Number VENTILTYP_NR Yes
Kvs KVS
Kvs_Kv0 KVS_KV0
linear equal percentage freely defined check valve KENNLINIENART

Table 10

Block/field Database link Keyword Compulsory Default
Prices for category 1 PREIS1
Prices for category 2 PREIS2
Prices for category 3 PREIS3
Prices for category 4 PREIS4
Prices for category 5 PREIS5
Prices for category 6 PREIS6
Valve model VENTILMODELL
Order_no. BESTELL_NR
Supplier LIEFERANT
Valve characteristic entry VENTIL_KENNLINIE
Number VENTILTYP_NR Yes
Position VENTIL_STELLUNG Yes
Valve coefficient VENTIL_KOEFF Yes
Organization group ORG_GRUPPE
Name ORG_ID Yes
Number ORG_NR Yes
Factor FAKTOR 1
Special fittings H_EINBAUTEILE
Number TEIL_NR Yes
Name TEIL_ID Yes
Zeta value ZETAWERT Yes
Special fittings pipe H_EINBAUTEILE_ROHR
Number ELEM_NR Yes
Partial identification TEIL_NR Yes
Number ANZAHL Yes

References to fields

  • All data blocks
    • Number – The number is the primary key and must be unique within all objects of a data block. Numbers always begin with 1.
    • • The data blocksSTRANG, VERBRAUCHER, VERSORGER, PUMPE, VENTIL, H_STEAMTRAP inherit the data from the ELEMENT data block. The field must be unique within all objects which inherit from
    • ELEMENT!
    • The inheritance is marked in the keyword column with the following line "< ELEMENT".
  • Conductor networks
    • Initial node – Is automatically set for suppliers in the conductor network.
    • End nodes – Is automatically set for consumers and steam traps in the conductor network.
  • Pipe class
    • INN_DMESS – The inside diameter is calculated if the fields for wall thickness and outside diameter are present.
    • KWERT – When this is available, the field WAERME_KOEFF from KWERT is calculated using the formula:
    • TheKWERT is carried out in the unit [W/mK]. This value must not be confused with the heat conductivity of the pipe insulating material! The fieldKWERT should not be defined together with the field WAERME_KOEFF.
    • WAERME_KOEFF – The heat transition coefficient of the pipe class in the Unit [W/m2K].
  • Steam trap – (only for long-distance heating one and two-leader networks)
    • ELEM_ID – The name of the steam trap comes from the name of the assigned node by prefixing the @ character.
      • The character @ is only allowed for steam traps as the first character (to guarantee clarity of the names).
      • A maximum of one steam trap exists for each node.

Old format

  • Name – The name must be unique within all objects within a data block.

New format

The format extends the existing specification with the following information.

  • Format Info
    • VERSION_ID – The version information block is only used in the extended format.
      • The number 080904 is to be used as version info of this specification.
  • General
    • Name – The name must be unique within all objects within a type of data block. Special rules are valid for the data blocksKNOTEN and the blocks inheriting fromELEMENT.
      • Here the name must be unique in combination with the network position.
      • The combination of name and network position only plays a role in the category long-distance heating.
      • Here node and pipe symmetries are illustrated by the fact that supply and return nodes receive the same name with different network positions. When they are transferred into the sisHYD database the network position abbreviations are added to the names (Network position identification: Supply (V), Return, KLB), so that the database-internal name is still unique. In the dialog masks the last letter is automatically hidden with nodes and pipes.
      • With conductor systems all node and pipe names contain a V contain as the last letter.